TimeStamp implements basic functionalities for time stamps. More...

#include <core/common/time_stamp.h>

Public Member Functions
	TimeStamp ()
	Constructor. More...

	TimeStamp (const TimeStamp &_ts)
	Copy constructor. More...

	TimeStamp (const double &_ts)
	Constructor with argument. More...

	TimeStamp (const unsigned long int &_sec, const unsigned long int &_nsec)
	Constructor from sec and nsec. More...

	~TimeStamp ()
	Destructor. More...

bool	ok () const

void	setOk ()

void	setNOk ()

void	setToNow ()
	Time stamp to now. More...

void	set (const timeval &ts)
	Set time stamp. More...

void	set (const unsigned long int &sec, const unsigned long int &nanosec)
	Set time stamp. More...

void	set (const double &ts)
	Set time stamp. More...

double	get () const
	Get time stamp. More...

unsigned long int	getSeconds () const
	Get time stamp (only seconds) More...

unsigned long int	getNanoSeconds () const
	Get time stamp (only nano seconds) More...

void	operator= (const double &ts)
	Assignement operator. More...

void	operator= (const TimeStamp &ts)
	Assignement operator. More...

bool	operator!= (const TimeStamp &ts) const
	comparison operator More...

bool	operator== (const TimeStamp &ts) const

bool	operator< (const TimeStamp &ts) const

bool	operator> (const TimeStamp &ts) const

bool	operator<= (const TimeStamp &ts) const
	comparison operator More...

bool	operator>= (const TimeStamp &ts) const

void	operator+= (const double &dt)
	Add-assign operator given a scalar_t (seconds) More...

TimeStamp	operator+ (const double &dt) const
	Add-assign operator given a scalar_t (seconds) More...

void	operator-= (const double &dt)
	Substraction-assign operator given a scalar_t (seconds) More...

TimeStamp	operator- (const double &ts) const
	difference operator More...

double	operator- (const TimeStamp &ts) const
	difference operator More...

void	print (std::ostream &ost=std::cout) const
	Prints time stamp to a given ostream. More...

std::string	string () const
	Returns a string with the Timestamp. More...

Static Public Member Functions
static TimeStamp	Invalid ()
	Value of time stamp is valid. More...

static TimeStamp	Now ()

Protected Attributes
unsigned long int	time_stamp_nano_
	Time stamp. Expressed in nanoseconds from 1th jan 1970. More...

bool	is_valid_

Friends
std::ostream &	operator<< (std::ostream &os, const TimeStamp &_ts)

Detailed Description

TimeStamp implements basic functionalities for time stamps.

TimeStamp implements basic functionalities for time stamps

Constructor & Destructor Documentation

◆ TimeStamp() [1/4]

wolf::TimeStamp::TimeStamp ( )

Constructor.

Constructor without arguments. Sets time stamp to now.

◆ TimeStamp() [2/4]

wolf::TimeStamp::TimeStamp ( const TimeStamp & _ts )

Copy constructor.

Copy constructor

◆ TimeStamp() [3/4]

wolf::TimeStamp::TimeStamp ( const double & _ts )

Constructor with argument.

Constructor with arguments

◆ TimeStamp() [4/4]

wolf::TimeStamp::TimeStamp	(	const unsigned long int &	_sec,
		const unsigned long int &	_nsec
	)

Constructor from sec and nsec.

Constructor from sec and nsec

◆ ~TimeStamp()

wolf::TimeStamp::~TimeStamp ( )

Destructor.

Destructor

Member Function Documentation

◆ get()

double wolf::TimeStamp::get ( ) const

inline

Get time stamp.

Returns time stamp

◆ getNanoSeconds()

unsigned long int wolf::TimeStamp::getNanoSeconds ( ) const

inline

Get time stamp (only nano seconds)

Returns nanoseconds part of time stamp

◆ getSeconds()

unsigned long int wolf::TimeStamp::getSeconds ( ) const

inline

Get time stamp (only seconds)

Returns seconds of time stamp

◆ Invalid()

wolf::TimeStamp wolf::TimeStamp::Invalid ( )

inlinestatic

Value of time stamp is valid.

◆ Now()

TimeStamp wolf::TimeStamp::Now ( )

static

◆ ok()

bool wolf::TimeStamp::ok ( ) const

inline

◆ operator!=()

bool wolf::TimeStamp::operator!= ( const TimeStamp & ts ) const

inline

comparison operator

Comparison operator

◆ operator+()

TimeStamp wolf::TimeStamp::operator+ ( const double & dt ) const

Add-assign operator given a scalar_t (seconds)

◆ operator+=()

void wolf::TimeStamp::operator+= ( const double & dt )

inline

Add-assign operator given a scalar_t (seconds)

◆ operator-() [1/2]

TimeStamp wolf::TimeStamp::operator- ( const double & ts ) const

difference operator

difference operator that returns a scalar_t (seconds)

◆ operator-() [2/2]

double wolf::TimeStamp::operator- ( const TimeStamp & ts ) const

inline

difference operator

difference operator that returns a Timestamp (seconds)

◆ operator-=()

void wolf::TimeStamp::operator-= ( const double & dt )

Substraction-assign operator given a scalar_t (seconds)

◆ operator<()

bool wolf::TimeStamp::operator< ( const TimeStamp & ts ) const

inline

◆ operator<=()

bool wolf::TimeStamp::operator<= ( const TimeStamp & ts ) const

inline

comparison operator

Comparison operator

◆ operator=() [1/2]

void wolf::TimeStamp::operator= ( const double & ts )

inline

Assignement operator.

Assignement operator

◆ operator=() [2/2]

void wolf::TimeStamp::operator= ( const TimeStamp & ts )

inline

Assignement operator.

Assignement operator given a scalar_t (seconds)

◆ operator==()

bool wolf::TimeStamp::operator== ( const TimeStamp & ts ) const

inline

◆ operator>()

bool wolf::TimeStamp::operator> ( const TimeStamp & ts ) const

inline

◆ operator>=()

bool wolf::TimeStamp::operator>= ( const TimeStamp & ts ) const

inline

◆ print()

void wolf::TimeStamp::print ( std::ostream & ost = std::cout ) const

Prints time stamp to a given ostream.

Prints time stamp to a given ostream

◆ set() [1/3]

void wolf::TimeStamp::set ( const double & ts )

inline

Set time stamp.

Sets time stamp to a given value passed as a scalar_t (seconds)

◆ set() [2/3]

void wolf::TimeStamp::set ( const timeval & ts )

inline

Set time stamp.

Sets time stamp to a given value passed as a timeval struct

◆ set() [3/3]

void wolf::TimeStamp::set	(	const unsigned long int &	sec,
		const unsigned long int &	nanosec
	)

inline

Set time stamp.

Sets time stamp to a given value passed as a two-integer (seconds and nanoseconds)

◆ setNOk()

void wolf::TimeStamp::setNOk ( )

inline

◆ setOk()

void wolf::TimeStamp::setOk ( )

inline

◆ setToNow()

void wolf::TimeStamp::setToNow ( )

Time stamp to now.

◆ string()

std::string wolf::TimeStamp::string ( ) const

inline

Returns a string with the Timestamp.

To be used by the logger

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const TimeStamp &	_ts
	)

friend

Member Data Documentation

◆ is_valid_

bool wolf::TimeStamp::is_valid_

protected

◆ time_stamp_nano_

unsigned long int wolf::TimeStamp::time_stamp_nano_

protected

Time stamp. Expressed in nanoseconds from 1th jan 1970.

The documentation for this class was generated from the following files:

include/core/common/time_stamp.h
src/common/time_stamp.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ TimeStamp() [1/4]

◆ TimeStamp() [2/4]

◆ TimeStamp() [3/4]

◆ TimeStamp() [4/4]

◆ ~TimeStamp()

Member Function Documentation

◆ get()

◆ getNanoSeconds()

◆ getSeconds()

◆ Invalid()

◆ Now()

◆ ok()

◆ operator!=()

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator<()

◆ operator<=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>()

◆ operator>=()

◆ print()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ setNOk()

◆ setOk()

◆ setToNow()

◆ string()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ is_valid_

◆ time_stamp_nano_